Skip to content

docs: rename sentencewindowretrieval to sentencewindowretriever - #11813

Merged
julian-risch merged 2 commits into
mainfrom
docs/fix-sentencewindowretriever-slug
Jun 29, 2026
Merged

docs: rename sentencewindowretrieval to sentencewindowretriever#11813
julian-risch merged 2 commits into
mainfrom
docs/fix-sentencewindowretriever-slug

Conversation

@bilgeyucel

Copy link
Copy Markdown
Contributor

Proposed Changes:

The existing page slug (/sentencewindowretrieval) used the technique name rather than the component class name (SentenceWindowRetriever). This makes the URL inconsistent with every other component docs page, which all use the class name as the slug.

  • Rename sentencewindowretrieval.mdx to sentencewindowretriever.mdx and updates the id and slug in its frontmatter to match the component name.
  • Update sidebars.js to point to the new filename

Follow up changes to #11793

How did you test it?

Ran it locally

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

@bilgeyucel bilgeyucel self-assigned this Jun 29, 2026
@bilgeyucel
bilgeyucel requested a review from a team as a code owner June 29, 2026 13:26
@bilgeyucel bilgeyucel added ignore-for-release-notes PRs with this flag won't be included in the release notes. documentation labels Jun 29, 2026
@bilgeyucel
bilgeyucel requested review from julian-risch and removed request for a team June 29, 2026 13:26
@vercel

vercel Bot commented Jun 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 29, 2026 1:31pm

Request Review

@claude

claude Bot commented Jun 29, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@julian-risch
julian-risch merged commit 03758a0 into main Jun 29, 2026
21 checks passed
@julian-risch
julian-risch deleted the docs/fix-sentencewindowretriever-slug branch June 29, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation ignore-for-release-notes PRs with this flag won't be included in the release notes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants